<?php
///////////////////////////////////////////////////////////////////////////////////////////////////////
//  这个文件是 JCAT PHP框架的一部，该项目和此文件 均遵循 GNU 自由软件协议
// 
//  Copyleft 2008 JeCat.cn(http://team.JeCat.cn)
//
//
//  JCAT PHP框架 的正式全名是：Jellicle Cat PHP Framework。
//  “Jellicle Cat”出自 Andrew Lloyd Webber的音乐剧《猫》（《Prologue:Jellicle Songs for Jellicle Cats》）。
//  JCAT 是一个开源项目，它像音乐剧中的猫一样自由，你可以毫无顾忌地使用JCAT PHP框架。JCAT 由中国团队开发维护。
//  正在使用的这个版本是：0.4.1 / SVN信息: $Id: class.JCAT_DBReturnColumn.php 1510 2009-03-23 06:51:00Z alee $
//
//
//
//  相关的链接：
//    [主页] http://jcat.JeCat.cn
//    [下载(HTTP)] http://code.google.com/p/jcat-php/downloads/list
//    [下载(svn)] svn checkout http://jcat-php.googlecode.com/svn/branches/0.4.0/Framework/ JCAT0.4
//    [在线文档] http://jcat.JeCat.cn/document
//    [社区] http://jj.jecat.cn/forum-7-1.html
//  不很相关：
//    [MP3] http://www.google.com/search?q=jellicle+songs+for+jellicle+cats+Andrew+Lloyd+Webber
//    [VCD/DVD] http://www.google.com/search?q=CAT+Andrew+Lloyd+Webber+video
//
///////////////////////////////////////////////////////////////////////////////////////////////////////
/*-- Project Introduce --*/




/**
 * 一个返回字段
 *
 * @author		alee
 * @access		public
 */
class JCAT_DBReturnColumn extends JCAT_DBObject
{
	/**
	 * 构造函数
	 * 
	 * @access	public
	 * @param	$aFactory	JCAT_DBAbstractFactory					对象工厂
	 * @param	$Clm		base,JCAT_DBColumn,JCAT_DBFunctionCall	字段
	 * @param	$sAlias=''	string										别名
	 * @return	void
	 */
	public function JCAT_DBReturnColumn( JCAT_DBAbstractFactory $aFactory, $Clm, $sAlias='' )
	{
		JCAT_ASSERT::ASSERT_ISTHESE($Clm,array('base','JCAT_DBColumn','JCAT_DBFunctionCall')) ;
		JCAT_ASSERT::ASSERT_STRING($sAlias) ;
					
		// 字段内容
		if( is_string($Clm) )
		{
			$this->aClm = $aFactory->CreateColumn($Clm) ;
		}
		elseif( JCAT_Global::IsThese($Clm,array('JCAT_DBColumn','JCAT_DBFunctionCall')) )
		{
			$this->aClm = $Clm ;
		}
		else
		{
			JCAT_ASSERT::ASSERT_(0,'!?')  ;
		}
		
		// 别名
		$this->sAlias = $sAlias ;
		
		$this->SetFactory($aFactory) ;
	}

	
	/**
	 * 创建并返回SQL语句
	 * 
	 * @access	public
	 * @return	string
	 */
	public function MakeSQL()
	{
		if( is_object($this->aClm) )
		{
			$sClmName = $this->aClm->MakeSQL() ;
		}
		else
		{
			$sClmName = "'{$this->aClm}'" ;
		}


		if( $sAlias=$this->GetAlias() )
		{
			return "{$sClmName} as '{$sAlias}'" ;
		}
		else
		{
			return $sClmName ;
		}
	}


	/**
	 * 返回别名
	 * 
	 * @access	public
	 * @return	string
	 */
	public function GetAlias(  ) 
	{ return $this->sAlias; }



	/**
	 * 设置别名
	 * 
	 * @access	public
	 * @param	$sAlias		string	别名
	 * @return	old_value
	 */
	public function SetAlias( $sAlias ) 
	{
		JCAT_ASSERT::ASSERT_STRING($sAlias) ;
		
		$old_value = $this->sAlias ;
		$this->sAlias = $sAlias ;
		return $old_value ;
	}

	/**
	 * 使用完整名称作为返回名称
	 *
	 * @access	public
	 * @return	void
	 */
	public function UseFullNameAlias()
	{
		$sTableName = $this->aClm->GetTableName() ;
		if( $sTableName )
		{
			$this->sAlias = $sTableName.'.'.$this->aClm->GetName() ;
		}
	}

	// 属性 ///////////////////////////////////////////////////////////////////////////////

	private $aClm ;
	
	// private $sTable ;
	
	private $sAlias ;
	
}
?>